Bot Chat

接口说明

使用该接口，可以实现使用Http请求与星辰应用开发平台创建的Bot进行流式、非流式对话。可以用于集成业务系统中。使用前，请先在星辰应用开发平台创建可用的Bot并发布。

请求地址

https://xingchen-api.xf-yun.com/agent/v1/chat/completions

请求方法

Http POST

鉴权

该接口使用API key进行鉴权。

进入星辰大模型应用平台，点击个人中心，进入Bots菜单Tab界面，点击bot卡片中的信息，进入API秘钥界面。

获取APIKey、APISecret和BotID。 鉴权 token 由 APIKey 和 APISecret 以冒号组合：

API_TOKEN = APIKey:APISecret

所有 API 请求都应在Authorization HTTP 标头中包含您的 API_TOKEN 密钥信息。

格式：

Authorization: Bearer API_TOKEN

示例：

Authorization: Bearer 09754ce66fe9baaadcc5f49de7776cmc:MDU5YjM4ODRmZGMxMDdiMTg3YzFmZtQz

请求示例

curl

curl --location --request POST 'https://agent.xf-yun.com/agent/v1/chat/completions' \
--header 'Authorization: Bearer 09754ce66fe9baaadcc5f49de7776cmc:MDU5YjM4ODRmZGMxMDdiMTg3YzFmZtQz' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--data '{
    "bot_id": "ef6123b9a427404b99b475f0134f2fcb",
    "uid": "123",
    "messages": [
        {
            "role": "user",
            "content": "你好啊"
        }
    ],
    "stream": "true"
}'

openai sdk

from openai import OpenAI


client = OpenAI(
    base_url="https://agent.xf-yun.com/v1",     
    api_key="09754ce66fe9baaadcc5f49de7776cmc:MDU5YjM4ODRmZGMxMDdiMTg3YzFmZtQz"
)

response = client.chat.completions.create(
    model="",  # 任意
    messages=[{"role": "user", "content": "你好"}],
    stream=True,
    extra_body={
        "bot_id": "ef6123b9a427404b99b475f0134f2fcb",
        "uid": "123"
    }
)
for resp in response:
    print("response::", resp)

返回示例

流式

data: {"code":0,"message":"Success","id":"cha000c0076@dx191c21ce879b8f3532","created":123412324431,"choices":[{"delta":{"role":"assistant","content":"","tool_calls":[{"type":"tool","function":{"name":"天气查询","arguments":"{\"city\": \"北京\", \"date\": \"2024-09-13\"}", "response": ""}}]}, "finish_reason":null}],"usage":{"prompt_tokens":null,"completion_tokens":null,"total_tokens":null}}

data: {"code":0,"message":"Success","id":"cha000c0076@dx191c21ce879b8f3532","created":123412324431,"choices":[{"delta":{"role":"assistant","content":"","tool_calls":[{"type":"tool","function":{"name":"天气查询","arguments":"{\"city\": \"南京\", \"date\": \"2024-09-13\"}", "response": ""}}]}, "finish_reason":null}],"usage":{"prompt_tokens":null,"completion_tokens":null,"total_tokens":null}}

data: {"code":0,"message":"Success","id":"cha000c0076@dx191c21ce879b8f3532","created":123412324431,"choices":[{"delta":{"role":"assistant","content":"明天北京"}, "finish_reason":null}],"usage":{"prompt_tokens":null,"completion_tokens":null,"total_tokens":null}}

data: {"code":0,"message":"Success","id":"cha000c0076@dx191c21ce879b8f3532","created":123412324431,"choices":[{"delta":{"role":"assistant","content":"的天气"}, "finish_reason":null}],"usage":{"prompt_tokens":null,"completion_tokens":null,"total_tokens":null}}

data: {"code":0,"message":"Success","id":"cha000c0076@dx191c21ce879b8f3532","created":123412324431,"choices":[{"delta":{"role":"assistant","content":"晴转多云"}, "finish_reason":null}],"usage":{"prompt_tokens":null,"completion_tokens":null,"total_tokens":null}}

data: {"code":0,"message":"Success","id":"cha000c0076@dx191c21ce879b8f3532","created":123412324431,"choices":[{"delta":{"role":"assistant","content":"气温是3"}, "finish_reason":null}],"usage":{"prompt_tokens":null,"completion_tokens":null,"total_tokens":null}}

data: {"code":0,"message":"Success","id":"cha000c0076@dx191c21ce879b8f3532","created":123412324431,"choices":[{"delta":{"role":"assistant","content":"0.4"}, "finish_reason":null}],"usage":{"prompt_tokens":null,"completion_tokens":null,"total_tokens":null}}

data: {"code":0,"message":"Success","id":"cha000c0076@dx191c21ce879b8f3532","created":123412324431,"choices":[{"delta":{"role":"assistant","content":"℃, 南"}, "finish_reason":null}],"usage":{"prompt_tokens":null,"completion_tokens":null,"total_tokens":null}}

data: {"code":0,"message":"Success","id":"cha000c0076@dx191c21ce879b8f3532","created":123412324431,"choices":[{"delta":{"role":"assistant","content":"京的天"}, "finish_reason":null}],"usage":{"prompt_tokens":null,"completion_tokens":null,"total_tokens":null}}

data: {"code":0,"message":"Success","id":"cha000c0076@dx191c21ce879b8f3532","created":123412324431,"choices":[{"delta":{"role":"assistant","content":"气晴，气"}, "finish_reason":null}],"usage":{"prompt_tokens":null,"completion_tokens":null,"total_tokens":null}}

data: {"code":0,"message":"Success","id":"cha000c0076@dx191c21ce879b8f3532","created":123412324431,"choices":[{"delta":{"role":"assistant","content":"温35℃"}, "finish_reason":null}],"usage":{"prompt_tokens":32,"completion_tokens":28,"total_tokens":60}}

data: [DONE]

非流式

{
    "code":0,
    "message":"Success",
    "id":"cha000c0076@dx191c21ce879b8f3532",
    "created": 123412324431,
    "choices":[
        {
            "message":{
                "role":"assistant",
                "content":"北京明天阴转多云，气温xx, 南京明天晴天，气温xxx...",
                "tool_calls": [
                     {
                         "type": "tool",
                         "function": {
                             "name": "天气查询",
                             "arguments": "{\"city\": \"北京\", \"date\": \"2024-09-13\"}",
                             "response": ""
                         }
                     },
                     {
                         "type": "tool",
                         "function": {
                             "name": "天气查询",
                             "arguments": "{\"city\": \"南京\", \"date\": \"2024-09-13\"}",
                             "response": ""
                         }
                     }   
                ]
            },
            "finish_reason": "stop"

        }
    ],
    "usage":{
        "prompt_tokens":25,
        "completion_tokens":26,
        "total_tokens":51
    }
}

请求参数说明

返回参数示例

流式

非流式

错误码